[CS2103T-W12-4] IchiFund #122
Conversation
|
|
||
| [appendix] | ||
| == Non Functional Requirements | ||
|
|
||
| . Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed. | ||
| . Should be able to hold up to 1000 persons without a noticeable sluggishness in performance for typical usage. | ||
| . Should be able to hold up to 1000 transactions without a noticeable sluggishness in performance for typical usage. | ||
| . A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse. |
There was a problem hiding this comment.
Should there be a well-defined benchmark to meet? (above average typing speed is subjective)
| @@ -79,14 +80,16 @@ image::UiClassDiagram.png[] | |||
|
|
|||
There was a problem hiding this comment.
Diagrams are really neat and matches your project (from what I can tell)
docs/DeveloperGuide.adoc
Outdated
| This feature allows the user to add a repeater in IchiFund. Adding a repeater also creates the transactions associated with the added repeater. | ||
|
|
||
| ==== Implementation | ||
| The `addrep` command is facilitated by the Logic and Model components of the application. Given below is an example usage scenario of how `addrep` behaves at each step. |
There was a problem hiding this comment.
Would be neater if you included a diagram.
| @@ -358,25 +699,24 @@ _{More to be added}_ | |||
| [[mainstream-os]] Mainstream OS:: | |||
There was a problem hiding this comment.
Could add terms like 'repeater' to the glossary as people might be unsure of what it means.
|
|
||
| *MSS* | ||
|
|
||
| 1. User requests to mark a lone as paid off. |
| ==== Adding Transactions | ||
| ===== Implementation | ||
| ===== Design Considerations | ||
| // end::transadd[] |
There was a problem hiding this comment.
Maybe can consider adding more activity diagrams.
| ==== Tasks | ||
| Some models in IchiFund must be refreshed after a command is executed. | ||
| For instance, when a new `Transaction` is added, all `Budget` must be recomputed. | ||
| `Task` can be used to facilitate such updates. | ||
|
|
||
| ===== Implementation | ||
| This feature is managed by `TaskManager`. | ||
| The role of `TaskManager` is to maintain a list of all active `Task`. | ||
|
|
||
| The `LogicManager` holds an instance of the `TaskManager`. | ||
| When the `LogicManager#execute()` is called, the following chain of operations occurs: | ||
|
|
||
| 1. After `Command#execute()` is completed, `TaskManager#executeAll()` is called. | ||
|
|
||
| image::TaskCode.png[] |
There was a problem hiding this comment.
An example usage scenario could be useful in making the purpose of Tasks clearer.
docs/DeveloperGuide.adoc
Outdated
| === Repeaters | ||
|
|
||
| // tag::repeateradd[] | ||
| === Adding Repeater : `addrep` |
There was a problem hiding this comment.
Will be better if this is a smaller heading as compared to the 'Repeaters' header.
|
|
||
| This process is further illustrated in the following sequence diagram: | ||
|
|
||
| .Sequence Diagram for `add` Command under Budget Tab |
There was a problem hiding this comment.
Diagram is neat and symbols are clear with good use of lifeline ending.
docs/DeveloperGuide.adoc
Outdated
| // end::repeateradd[] | ||
|
|
||
| // tag::repeaterdelete[] | ||
| === Deleting Repeater : `delrep` |
There was a problem hiding this comment.
Probably will be better to include a sequence diagram.
|
|
||
| // tag::tasks[] | ||
| ==== Tasks | ||
| Some models in IchiFund must be refreshed after a command is executed. |
There was a problem hiding this comment.
Probably will be better to include the models that will be affected
docs/DeveloperGuide.adoc
Outdated
|
|
||
| The `UI` component uses JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the link:{repoURL}/src/main/java/seedu/address/ui/MainWindow.java[`MainWindow`] is specified in link:{repoURL}/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`] | ||
|
|
||
| The `UI` component, | ||
|
|
||
| * Executes user commands using the `Logic` component. | ||
| * Listens for changes to `Model` data so that the UI can be updated with the modified data. | ||
| * Listens for changes to the index of the `FeatureParser` used by the `Logic` component to change tabs. | ||
| * Sets the `FeatureParser` used by the `Logic` component when the user manually changes tabs. | ||
|
|
||
| [[Design-Logic]] | ||
| === Logic component |
There was a problem hiding this comment.
Diagram is similar to the 2.1 Architecture diagram. Probably will be better to include a reference instead of repeating the diagram. Arrows can be bigger for the association and dependency arrows.
Add edge cases
Tweak repeater documentation
…Alaete/main into update-developer-guide-and-ppp-for-v1.4
…r-v1.4 Update DG for v1.4
Update PPP
Fix some errors in UG DG PPP
# Conflicts: # docs/DeveloperGuide.adoc
Add test cases in DG; other team tasks
… fix-user-guide-for-v1.4
Final PR for this CS2103T
Fix user guide for v1.4 and implement UpdateReportTask
Update version number
No description provided.